Document release process #768

chuckha · 2019-02-22T16:54:26Z

Signed-off-by: Chuck Ha [email protected]

What this PR does / why we need it:
This PR documents the release process for this repository. The eventual goal is to understand the pieces of release and come up with automated systems. There is potential for sharing this work

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #764
Related to #732

Special notes for your reviewer:
This is a best guess at how release works.

NONE

/cc @roberthbailey

detiber · 2019-02-22T17:38:51Z

/assign @roberthbailey

davidewatson · 2019-02-22T22:19:52Z

docs/developer/releasing.md

+
+1. Push a git tag
+2. Build and push the container image with `make docker-push`. Note: This
+   container  registry has extremely limited access. You likely do not have


Can/should we link to documentation on who has authority?

I'd guess @roberthbailey knows and can help provide additional context to this document

vincepri

/approve

k8s-ci-robot · 2019-02-26T18:34:04Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chuckha, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

roberthbailey · 2019-02-27T18:46:01Z

docs/developer/releasing.md

+# Process
+
+1. Push a git tag
+2. Build and push the container image with `make docker-push`. Note: This


You either need to set CONTROLLER_IMG before running the make command or edit the Makefile so that the pushed image has the correct tag.

If we have to do a PR dance to cut a release (to embed version numbers) then it might make sense to have that include editing the version in the Makefile too).

roberthbailey · 2019-02-27T18:48:40Z

docs/developer/releasing.md

+
+# Process
+
+1. Push a git tag


Also need to set the image version in the generated yaml so that when the providers vendor the git tag their will start the correct container image.

See #635

chuckha · 2019-02-27T21:52:16Z

@roberthbailey thank you for the feedback! I updated the pr, ptal

ncdc · 2019-03-01T21:31:20Z

docs/developer/releasing.md

+
+## Process
+
+1. Create a pull request that contains two changes:


For Velero, we use goreleaser and have a custom script that executes at release time (after the git tag has been created) that uses sed to find/replace :latest with the appropriate version string to match the git tag. That way, we don't have to open a PR, cut the release, then revert the PR. Would you be interested in exploring something like this down the road?

I think anything that reduces the number of steps involved with releasing should be considered. I'll add a note in the Cluster API Provider Releases doc about goreleaser.

ncdc · 2019-03-05T16:21:43Z

docs/developer/releasing.md

+1. Create a pull request that contains two changes:
+   1. Change [the cluster api controller manager image
+   tag][managerimg] from `:latest` to whatever version is being released
+   2. Change the `CONTROLLER_IMAGE` variable in the [Makefile][makefile] to the


Did you mean CONTROLLER_IMG?

Yep, that's the variable name

ncdc · 2019-03-05T16:26:02Z

docs/developer/releasing.md

+## Process
+
+1. Create a pull request that contains two changes:
+   1. Change [the cluster api controller manager image


Could we get a Makefile target that can make these changes, and second target to undo them?

I agree, this PR dance is by far the most onerous part of the release process.

It reminds me of Maven releases 😄

ncdc · 2019-03-05T16:26:43Z

@roberthbailey @chuckha what's left to get this merged?

chuckha · 2019-03-05T19:04:13Z

@ncdc I'm waiting for @roberthbailey's feedback. I've only written down what I can assume are the steps to releasing, he's the only one (?) that's done it and I'd like this document to reflect the real process.

roberthbailey

Sorry for the delay. I think most of the steps are covered, just missing the line item for generating release notes.

roberthbailey · 2019-03-06T18:15:42Z

docs/developer/releasing.md

+6. Open a pull request with the revert change
+7. Get that pull request merged
+8. Create a release in github based on the tag created above
+


Step 9 is to write release notes. Right now this is also a very manual process. For https://github.com/kubernetes-sigs/cluster-api/releases/tag/0.0.0-alpha.3 I basically went through all of the PRs that had merged since the prior release and manually curated the release notes. It's onerous, but the script in the k/k repo that does it didn't seem like it would work out of the box even though we use the same release notes block in our PRs. As you can tell, when I cut https://github.com/kubernetes-sigs/cluster-api/releases/tag/0.0.0-alpha.4 during kubecon I didn't have the time to make similarly thorough release notes.

I've filed #327 to track building better automation for release note generation.

roberthbailey · 2019-03-06T18:25:05Z

docs/developer/releasing.md

+
+### Permissions
+
+Releasing requires a particular set of permissions.


It sounds like this will change soon with the community owns staging buckets and the image promoter automation that is being built. But for now, this is how it's done.

ncdc · 2019-03-06T19:37:07Z

/milestone v1alpha1

Signed-off-by: Chuck Ha <[email protected]>

detiber · 2019-03-06T19:43:13Z

/lgtm

chuckha · 2019-03-06T19:53:56Z

/retest

k8s-ci-robot requested a review from roberthbailey February 22, 2019 16:54

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 22, 2019

k8s-ci-robot assigned roberthbailey Feb 22, 2019

davidewatson reviewed Feb 22, 2019

View reviewed changes

vincepri approved these changes Feb 26, 2019

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 26, 2019

roberthbailey reviewed Feb 27, 2019

View reviewed changes

chuckha force-pushed the reldoc branch from 58a1eea to e31742f Compare February 27, 2019 21:30

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 27, 2019

chuckha force-pushed the reldoc branch from e31742f to 623078a Compare February 27, 2019 21:42

ncdc reviewed Mar 1, 2019

View reviewed changes

chuckha mentioned this pull request Mar 4, 2019

Document versioning and release process kubernetes-sigs/cluster-api-provider-azure#97

Closed

ncdc reviewed Mar 5, 2019

View reviewed changes

ncdc mentioned this pull request Mar 5, 2019

Provider Release(s) #732

Closed

roberthbailey reviewed Mar 6, 2019

View reviewed changes

k8s-ci-robot added this to the v1alpha1 milestone Mar 6, 2019

Document release process

362186d

Signed-off-by: Chuck Ha <[email protected]>

chuckha force-pushed the reldoc branch from 623078a to 362186d Compare March 6, 2019 19:40

k8s-ci-robot assigned detiber Mar 6, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 6, 2019

k8s-ci-robot merged commit bf5d7f4 into kubernetes-sigs:master Mar 6, 2019

ncdc mentioned this pull request Oct 24, 2019

📖 Document breaking changes policy #1637

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document release process #768

Document release process #768

chuckha commented Feb 22, 2019

detiber commented Feb 22, 2019

davidewatson Feb 22, 2019

chuckha Feb 26, 2019

vincepri left a comment

k8s-ci-robot commented Feb 26, 2019

roberthbailey Feb 27, 2019

roberthbailey Feb 27, 2019

roberthbailey Feb 27, 2019

chuckha commented Feb 27, 2019

ncdc Mar 1, 2019

chuckha Mar 4, 2019

ncdc Mar 5, 2019

chuckha Mar 5, 2019

ncdc Mar 5, 2019

chuckha Mar 5, 2019

ncdc Mar 5, 2019

ncdc commented Mar 5, 2019

chuckha commented Mar 5, 2019

roberthbailey left a comment

roberthbailey Mar 6, 2019

roberthbailey Mar 6, 2019

ncdc commented Mar 6, 2019

detiber commented Mar 6, 2019

chuckha commented Mar 6, 2019


		## Process

		1. Create a pull request that contains two changes:


		### Permissions

		Releasing requires a particular set of permissions.

Document release process #768

Document release process #768

Conversation

chuckha commented Feb 22, 2019

detiber commented Feb 22, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincepri left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Feb 26, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chuckha commented Feb 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ncdc commented Mar 5, 2019

chuckha commented Mar 5, 2019

roberthbailey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ncdc commented Mar 6, 2019

detiber commented Mar 6, 2019

chuckha commented Mar 6, 2019